Format after building #1166
Format after building #1166
Conversation
| </PropertyGroup> | ||
| </Target> | ||
| <PropertyGroup> | ||
| <_BuildProjBaseIntermediateOutputPath>$(MSBuildThisFileDirectory)build/obj/</_BuildProjBaseIntermediateOutputPath> |
There was a problem hiding this comment.
I need some Chetfu here to make this not hardcoded to build's immediate output path but i'm not sure exactly how to ask for a specific project's value.
There was a problem hiding this comment.
This is gonna be gross. I think you'll have to have a 'GetIntermediateOutputPathtarget in here that would return the value of theBaseIntermediateOutputPath` property for the project it was part of. Then you'd call that target on the build project during execution.
This dependency is why you often see features like this come in two targets:
- one to set up any data dependencies and generate the properties/paths for any inputs/outputs to the real target
- and the the real target the does the thing and uses the properties/items set up in the first target
this split is so that you always can set up your Inputs/Outputs and not run into issues with incrementality.
There was a problem hiding this comment.
@rainersigwald - we in the SDK get requests somewhat often for something like this: 'restore tools as part of my build'. Does anything here jump out as especially bad? Could we potentially extract some kind of recommendation in lieu of first class SDK level support?
| <Target Name="ToolRestore" BeforeTargets="Restore;CollectPackageReferences;PaketRestore" Inputs="$(_DotnetToolManifestFile)" Outputs="$(_DotnetToolRestoreOutputFile)"> | ||
| <Exec Command="dotnet tool restore" WorkingDirectory="$(MSBuildThisFileDirectory)" StandardOutputImportance="High" StandardErrorImportance="High" /> | ||
| <MakeDir Directories="$(_BuildProjBaseIntermediateOutputPath)"/> | ||
| <Touch Files="$(_DotnetToolRestoreOutputFile)" AlwaysCreate="True" ForceTouch="True" /> | ||
| </Target> |
There was a problem hiding this comment.
Inspired by FSharp.SystemTextJson but I worked out some more issues in MiniScaffold
| <Target Name="Format" BeforeTargets="BeforeBuild" Inputs="@(Compile)" Outputs="$(_DotnetFantomasOutputFile)" > | ||
| <Exec Command="dotnet fantomas $(MSBuildProjectDirectory)" StandardOutputImportance="High" StandardErrorImportance="High" WorkingDirectory="$(MSBuildThisFileDirectory)" /> | ||
| <Touch Files="$(_DotnetFantomasOutputFile)" AlwaysCreate="True" ForceTouch="True" /> | ||
| </Target> |
There was a problem hiding this comment.
This does mean it runs per project, but it's incremental per project.
There was a problem hiding this comment.
This is the sane way to do it, since everything in MSBuild is project-based. Note that we would lose the ability to format any non-project-included files (but that's probably ok).
| <ItemGroup> | ||
| <FormatInputs Include="src/**/*.fs;src/**/*.fsi" Exclude="src/**/obj/**/*.fs" /> | ||
| </ItemGroup> |
There was a problem hiding this comment.
Using .fantomasignore
| test/ | ||
| build/ | ||
| benchmarks/ | ||
| utils/ | ||
| demo.fsx |
There was a problem hiding this comment.
Replicated from Directory.Solution.targets. We should probably start considering formatting these at some point.
| "[fsharp]": { | ||
| "editor.formatOnSave": true |
There was a problem hiding this comment.
Why not on save as well.
|
Oh of course tests are gonna fail because I'm using |
|
Just gonna close this for now. We'll just let CI make someone angry enough again to do this. |
WHAT
🤖 Generated by Copilot at 1723ad8
This pull request adds and modifies some files to integrate the Fantomas tool for formatting F# code. It enables automatic formatting on save in VS Code, and adds targets to restore and run Fantomas as part of the build process. It also adds a
.fantomasignorefile to exclude non-source files from formatting.🤖 Generated by Copilot at 1723ad8
📝🛠️🏗️
WHY
Let's make it harder to fail CI formatting.
HOW
🤖 Generated by Copilot at 1723ad8
.fantomasignorefile to exclude non-source files from formatting (link)Directory.Build.targets(link).fantomasignorefile inDirectory.Solution.targets(link)